home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / gnome-doc-utils / templates / gnome-applet-template.xml < prev    next >
Encoding:
Extensible Markup Language  |  2009-09-22  |  20.0 KB  |  526 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
  3. "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  4.   <!ENTITY applet "<application>MY-GNOME-APPLET</application>">
  5.   <!ENTITY appletversion "2.0">
  6.   <!ENTITY manrevision   "2.0">
  7.   <!ENTITY date "March 2002">
  8.  
  9.   <!-- Information about the entities.
  10.        The legal.xml file contains legal information, there is no need to edit the file. 
  11.        Use the appletversion entity to specify the version of the applet.
  12.        Use the manrevision entity to specify the revision number of this manual.
  13.        Use the date entity to specify the release date of this manual.
  14.        Use the applet entity to specify the name of the applet. -->
  15.  
  16. ]>
  17. <!-- 
  18.   This is a GNOME documentation template, designed by the GNOME
  19.   Documentation Project Team. Please use it for writing GNOME
  20.   documentation, making obvious changes. In particular, all the words
  21.   written in UPPERCASE (with the exception of GNOME) should be
  22.   replaced. As for "legalnotice", please leave the reference
  23.   unchanged.
  24.  
  25.   Remember that this is a guide, rather than a perfect model to follow
  26.   slavishly. Make your manual logical and readable.  And don't forget
  27.   to remove these comments in your final documentation!  ;-)
  28. -->
  29. <!-- 
  30.       (Do not remove this comment block.)
  31.   Maintained by the GNOME Documentation Project
  32.   http://developer.gnome.org/projects/gdp
  33.   Template version: 3.0 beta
  34.   Template last modified 2006-12-10 and whatever it says in CVS
  35. -->
  36. <!-- =============Document Header ============================= -->
  37.  
  38. <article id="index" lang="en">
  39. <!-- do not change this id, but replace id="myapplet-" throughout -->
  40.  
  41.  
  42.   <articleinfo> 
  43.       <title>&applet; Applet Manual</title> 
  44.     <abstract role="description">
  45.       <para>&applet; is ... <!-- insert brief description -->.</para>
  46.     </abstract>
  47.     
  48.     <copyright> 
  49.       <year>2006</year> 
  50.       <holder>GNOME Documentation Project</holder> 
  51.     </copyright> 
  52.  
  53.     <!-- An address can be added to the publisher information. -->
  54.     <publisher role="maintainer"> 
  55.       <publishername>GNOME Documentation Project</publishername> 
  56.     </publisher>
  57.  
  58.       <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
  59.     <!-- The file legal.xml contains link to license for the documentation, 
  60.         and other legal stuff such as "NO WARRANTY" statement. 
  61.         Please do not change any of this. -->
  62.  
  63.     <authorgroup> 
  64.       <author> 
  65.             <firstname>Documentation</firstname> 
  66.             <surname>Writer 2</surname> 
  67.             <affiliation> 
  68.                 <orgname>GNOME Documentation Project</orgname> 
  69.                 <!-- The email address of the author is optional and is commented out by default. 
  70.               <address> <email>doc-writer2@gnome.org</email> </address> 
  71.               -->
  72.             </affiliation> 
  73.       </author> 
  74.       <author> 
  75.             <firstname>Documentation</firstname> 
  76.             <surname>Writer 1</surname> 
  77.             <affiliation> 
  78.                 <orgname>GNOME Documentation Project</orgname> 
  79.                 <!-- The email address of the author is optional and is commented out by default. 
  80.               <address> <email>doc-writer2@gnome.org</email> </address> 
  81.               -->
  82.             </affiliation> 
  83.       </author> 
  84.     </authorgroup>
  85.  
  86. <!-- According to GNU FDL, revision history is mandatory if you are -->
  87. <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
  88. <!-- Remember to remove the &manrevision; entity from the revision entries other
  89. -->
  90. <!-- than the current revision. -->
  91. <!-- The revision numbering system for GNOME manuals is as follows: -->
  92. <!-- * the revision number consists of two components -->
  93. <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
  94. <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
  95. <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
  96. <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
  97. <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
  98. <!-- to V3.0, and so on. -->  
  99.      <revhistory>
  100.         <revision> 
  101.           <revnumber>&applet; Applet Manual V&manrevision;</revnumber> 
  102.           <date>&date;</date> 
  103.           <revdescription> 
  104.              <para role="author">Documentation Writer 2
  105.                 <email>docwriter2@gnome.org</email></para> 
  106.              <para role="publisher">GNOME Documentation Project</para> 
  107.           </revdescription> 
  108.         </revision> 
  109.         <revision> 
  110.           <revnumber>Full title of previous manual.</revnumber> 
  111.           <date>Release date of previous manual.</date> 
  112.           <revdescription> 
  113.              <para role="author">Documentation Writer 1
  114.                 <email>docwriter2@gnome.org</email></para> 
  115.              <para role="publisher">GNOME Documentation Project</para> 
  116.           </revdescription> 
  117.         </revision> 
  118.      </revhistory> 
  119.      <releaseinfo> This manual describes version &appletversion; of &applet;.
  120.         </releaseinfo> 
  121.         
  122.     <legalnotice> 
  123.       <title>Feedback</title> 
  124.       <para>To report a bug or make a suggestion regarding the &app; applet or
  125.       this manual, follow the directions in the 
  126.       <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>. 
  127.       </para>
  128. <!-- Translators may also add here feedback address for translations -->
  129.     </legalnotice> 
  130.     
  131.   </articleinfo> 
  132.   <indexterm zone="index"> 
  133.      <primary>MY-GNOME-APPLET</primary> 
  134.   </indexterm> 
  135.   <indexterm zone="index"> 
  136.      <primary>mygnomeapplet</primary> 
  137.   </indexterm>
  138. <!-- ============= Document Body ============================= -->
  139. <!-- ============= Introduction ============================== -->
  140. <!-- Use the Introduction section to give a brief overview of what
  141.      the applet is and what it does. -->
  142.   <sect1 id="myapplet-introduction"> 
  143.     <title>Introduction</title> 
  144.     <!-- You should start the Introduction with a screenshot of the applet in a panel -->
  145.  
  146.     <!-- ==== Figure ============================================= -->
  147.     <informalfigure id="myapplet-fig"> 
  148.     <screenshot> 
  149.       <mediaobject> 
  150.          <imageobject><imagedata fileref="figures/myapplet_applet.png"
  151.             format="PNG"/> 
  152.          </imageobject>
  153.       <!-- EPS versions of the figures are not required at the moment. -->
  154.     <!-- 
  155.         <imageobject>
  156.               <imagedata fileref="figures/myapplet_applet.ps" format="EPS"/>
  157.                 </imageobject>
  158.         -->
  159.          <textobject> 
  160.             <phrase>Shows &applet; applet. Contains default character buttons.
  161.             </phrase> 
  162.          </textobject> 
  163.       </mediaobject> 
  164.     </screenshot> 
  165.     </informalfigure> 
  166.     <!-- ==== End of Figure ======================================= -->
  167.  
  168.     <para>
  169.     Use &applet; applet to quickly access magic beans from a panel.
  170.     With &applet;, you can plant beans, watch the grow, and climb up them to kill giants.
  171.     </para>
  172.  
  173.     <para>To add &applet; to a panel:</para>
  174.     <orderedlist>
  175.       <listitem>
  176.         <para>Right-click on the panel to open the panel popup menu, then choose 
  177.         <menuchoice> 
  178.           <guimenu>Add to Panel</guimenu>
  179.         </menuchoice>.
  180.         </para>
  181.       </listitem>
  182.       <listitem>
  183.         <para>Select &applet; in the <guilabel>Add to Panel</guilabel> dialog, then click <guibutton>Add</guibutton>.</para>
  184.       </listitem>
  185.     </orderedlist>
  186.     <para>
  187.     For more information on adding &applet; to a panel, see the <ulink url="ghelp:user-guide?panels-addobject" type="help">GNOME User Guide</ulink>.
  188.      </para> 
  189.   </sect1>
  190.  
  191. <!-- ================ Usage ================================ -->
  192. <!-- Use this section to describe how to use the applet to perform the tasks for 
  193.      which the applet is designed. -->
  194.   <sect1 id="myapplet-usage"> 
  195.      <title>Usage</title> 
  196.      <para>When you add &applet; to a panel for the
  197.         first time, the applet displays a default list of characters. You can select a
  198.         character from the default list, or you can select a character from predefined
  199.         groups of characters. Each predefined group of characters is associated with a
  200.         standard character on your keyboard. 
  201.     </para>
  202.  
  203.      <!-- ================ Usage Subsection ================================ -->
  204.      <sect2 id="myapplet-charselect"> 
  205.         <title>Topic 1</title> 
  206.         <para>To select a character from the applet
  207. and insert the character into a text 
  208.         string, perform the following steps: 
  209.           <orderedlist> 
  210.              <listitem> 
  211.                 <para>Click on the character in the applet that you require. The
  212.                   character button is pressed in to indicate that the character is selected.
  213.                   </para> 
  214.              </listitem> 
  215.              <listitem> 
  216.                 <para>Point to the location in an application where you want to put
  217.                   the character and middle-click to insert the character. You can also paste the
  218.                   character into the application if a paste facility is available. You can repeat
  219.                   the insertion as many times as you want because the character remains selected
  220.                   until you click on another character in the applet. </para> 
  221.              </listitem> 
  222.           </orderedlist></para> 
  223.         <para>Some applications do not support the full ISO-8859-1 character set
  224.           specification. You can not insert unsupported characters into an
  225.           application.</para> 
  226.      </sect2> 
  227.     <!-- ================ Usage Subsection ================================ -->
  228.  
  229.      <sect2 id="myapplet-display-chargroup"> 
  230.         <title>Topic 2</title> 
  231.         <para>You can change the characters that are displayed in the applet from
  232.           the default list to a predefined group of characters.</para> 
  233.         <para>To display a group of predefined characters, perform the following
  234.           steps: 
  235.           <orderedlist> 
  236.              <listitem> 
  237.                 <para>Click on any character in the default list to activate the
  238.                   applet. </para> 
  239.              </listitem> 
  240.              <listitem> 
  241.                 <para>Press the keyboard character that is associated with the
  242.                   group of characters that you want to display. For example, press 
  243.                   <keycap>A</keycap> to display the group of characters in the
  244.                   following figure. 
  245.               <!-- ==== Figure ============================================= -->
  246.  
  247.                   <figure id="myapplet-fig2"> 
  248.                      <title>Character Group Associated With the A Key</title> 
  249.                      <screenshot> 
  250.                         <mediaobject> 
  251.                           <imageobject><imagedata fileref="figures/myapplet_fig2"
  252.                              format="PNG"/> 
  253.                           </imageobject>
  254.               <!-- EPS versions of the figures are not required at the moment. -->
  255. <!-- 
  256.                       <imageobject>
  257.                       <imagedata fileref="figures/myapplet_fig2" format="EPS"/>
  258.                        </imageobject>
  259.                 -->
  260.                           <textobject> 
  261.                              <phrase>Screen shot of the character group associated
  262.                                 with the "A" key. </phrase> 
  263.                           </textobject> 
  264.                         </mediaobject> 
  265.                      </screenshot> 
  266.                   </figure> 
  267.               <!-- ==== End of Figure ======================================= -->
  268.  
  269.                 </para> 
  270.              </listitem> 
  271.           </orderedlist></para> 
  272.         <para>You can select the character that you require from the group of
  273.           characters in the applet, then insert the character into your text string.
  274.           </para> 
  275.         <para>The following chart lists keyboard characters and their associated
  276.           groups of characters. The keyboard characters are listed in the first column of
  277.           each section in the chart. The character groups that are associated with each
  278.           keyboard character are shown in the other columns. </para>
  279.       <!-- ==== Figure ============================================= -->
  280.         <figure id="myapplet-fig3"> 
  281.           <title>Character Groups Associated With Keyboard Keys</title> 
  282.           <screenshot> 
  283.              <mediaobject> 
  284.                 <imageobject><imagedata fileref="figures/myapplet_fig3"
  285.                   format="PNG"/> 
  286.                 </imageobject>
  287.  
  288.           <!-- EPS versions of the figures are not required at the moment. -->
  289. <!-- 
  290.             <imageobject>
  291.               <imagedata fileref="figures/myapplet_fig3" format="EPS"/>
  292.                 </imageobject>
  293.             -->
  294.                 <textobject> 
  295.                   <phrase>Screen shot of character groups associated with various
  296.                      keyboard keys. </phrase> 
  297.                 </textobject> 
  298.              </mediaobject> 
  299.           </screenshot> 
  300.         </figure> 
  301.       <!-- ==== End of Figure ======================================= -->
  302.      </sect2> 
  303.     <!-- ================ Usage Subsection ================================ -->
  304.      <sect2 id="myapplet-default-list"> 
  305.         <title>Topic 3</title> 
  306.         <para>To return to the current default character list, click on any
  307.           character in the applet, then press the space bar on your keyboard. </para> 
  308.      </sect2>
  309.  
  310.     <!-- ================ Usage Subsection ================================ -->
  311.      <sect2 id="myapplet-default-new"> 
  312.         <title>Topic 4</title> 
  313.         <para>You can use a character selection application such as
  314.           <application>GNOME Character Map</application> to set up a new default list.
  315.           For example, to create a new default list with <application>GNOME Character
  316.           Map</application>, perform the following steps: </para> 
  317.         <orderedlist> 
  318.           <listitem> 
  319.              <para> Right-click anywhere in the applet, then select 
  320.                 <guimenuitem>Properties</guimenuitem>. </para> 
  321.           </listitem> 
  322.           <listitem> 
  323.              <para> In the 
  324.                 <guilabel>Character Picker Settings</guilabel> dialog, click on the
  325.                 
  326.                 <guilabel>Default List</guilabel> tab. </para> 
  327.           </listitem> 
  328.           <listitem> 
  329.              <para> Select the contents of the 
  330.                 <guilabel>Default character list</guilabel> text box, then press 
  331.                 <keycap>Back Space</keycap> to delete the current default list.
  332.                 </para> 
  333.           </listitem> 
  334.           <listitem> 
  335.              <para> Open <application>GNOME Character Map</application>, then
  336.                 select the characters you want for your new default list. You can select up to
  337.                 25 characters. </para> 
  338.           </listitem> 
  339.           <listitem> 
  340.              <para> Copy the contents of the 
  341.                 <guilabel>Text to copy</guilabel> text box from <application>GNOME
  342.                 Character Map</application> to the 
  343.                 <guilabel>Default character list</guilabel> text box. </para> 
  344.           </listitem> 
  345.           <listitem> 
  346.              <para> Click 
  347.                 <guibutton>Apply</guibutton> to view the new default list in the
  348.                 applet, then click 
  349.                 <guibutton>OK</guibutton>. </para> 
  350.           </listitem> 
  351.         </orderedlist> 
  352.      </sect2> 
  353.     <!-- ================ Usage Subsection ================================ -->
  354.  
  355.      <sect2 id="myapplet-change-size"> 
  356.         <title>Topic 5</title> 
  357.         <para>You can configure the size characteristics of the applet in the
  358.           following ways: 
  359.           <itemizedlist> 
  360.              <listitem> 
  361.                 <para>To make the applet adjust to fit into a panel, select the 
  362.                   <guilabel>Follow panel size</guilabel> option, see 
  363.                   <xref linkend="myapplet-size"/>. The only other options you
  364.                   can specify in this case are the minimum number of cells and the size of the
  365.                   cells. The applet adjusts the number of rows and columns to fit the display to
  366.                   the panel dimensions in the most optimum way. </para> 
  367.              </listitem> 
  368.              <listitem> 
  369.                 <para>To make the panel adjust to accommodate the applet, deselect
  370.                   the 
  371.                   <guilabel>Follow panel size</guilabel> option, see 
  372.                   <xref linkend="myapplet-size"/>. You can choose the number of
  373.                   rows, the number of columns and the size of the cells. The configuration you
  374.                   specify might produce a display size that is larger than the panel dimensions,
  375.                   in which case the panel adjusts in size to accept the applet. </para> 
  376.              </listitem> 
  377.           </itemizedlist></para> 
  378.      </sect2> 
  379.   </sect1>
  380.  
  381. <!-- ============= Customization ============================= -->
  382. <!-- Use this section to describe how to customize the applet. -->
  383.   <sect1 id="myapplet-prefs"> 
  384.      <title>Settings</title> 
  385.      <para>To configure &applet;, right-click on the
  386.         applet, then choose 
  387.         <guimenuitem>Properties</guimenuitem> from the popup menu.</para> 
  388.      <para>The 
  389.         <guimenuitem>Properties</guimenuitem> dialog contains the following
  390.         tabbed sections: </para> 
  391.      <itemizedlist> 
  392.         <listitem> 
  393.           <para> 
  394.              <xref linkend="myapplet-size"/></para> 
  395.         </listitem> 
  396.         <listitem> 
  397.           <para> 
  398.              <xref linkend="myapplet-set-default"/></para> 
  399.         </listitem> 
  400.      </itemizedlist>
  401.  
  402.  
  403. <!-- =============== Customization Subsection ================ -->
  404. <!-- Use a new section to describe different tabbed sections on the Settings or Preferences
  405.          dialog. -->
  406.      <sect2 id="myapplet-size"> 
  407.         <title>Size</title> 
  408.         <variablelist> 
  409.           <varlistentry> 
  410.              <term> 
  411.                 <guilabel>Follow panel size</guilabel></term> 
  412.              <listitem> 
  413.                 <para>Select this option to automatically set the appropriate
  414.                   number of columns and rows of characters in the applet to fit in your
  415.                   panel.</para> 
  416.                 <para>Default: selected.</para> 
  417.              </listitem> 
  418.           </varlistentry> 
  419.           <varlistentry> 
  420.              <term> 
  421.                 <guilabel>Minimum number of cells: (for autosize)</guilabel></term>
  422.  
  423.              
  424.              <listitem> 
  425.                 <para>Use this spin box to specify the minimum number of character
  426.                   cells in the applet. You can specify up to 25 cells. If you specify a low
  427.                   minimum number of cells, some characters might not be visible.</para> 
  428.                 <para>Default: 8 cells.</para> 
  429.              </listitem> 
  430.           </varlistentry> 
  431.           <varlistentry> 
  432.              <term> 
  433.                 <guilabel>Number of rows of buttons</guilabel></term> 
  434.              <listitem> 
  435.                 <para>Use this spin box to specify the number of character rows in
  436.                   the applet. You can specify up to 5 rows. </para> 
  437.                 <para>Default: 2 rows.</para> 
  438.              </listitem> 
  439.           </varlistentry> 
  440.           <varlistentry> 
  441.              <term> 
  442.                 <guilabel>Number of columns of buttons</guilabel></term> 
  443.              <listitem> 
  444.                 <para>Use this spin box to specify the number of character columns
  445.                   in the applet. You can specify up to 5 columns.</para> 
  446.                 <para>Default: 4 columns. </para> 
  447.              </listitem> 
  448.           </varlistentry> 
  449.           <varlistentry> 
  450.              <term> 
  451.                 <guilabel>Size of buttons: (pixels)</guilabel></term> 
  452.              <listitem> 
  453.                 <para>Use this spin box to specify the size in pixels of each
  454.                   character cell in the applet. You can specify a button size up to 40
  455.                   pixels.</para> 
  456.                 <para>Default: 22 pixels.</para> 
  457.              </listitem> 
  458.           </varlistentry> 
  459.         </variablelist> 
  460.      </sect2>
  461.  
  462. <!-- ============= Customization Subsection ===================== -->
  463. <!-- Another tabbed section on the Preferences dialog. -->
  464.      <sect2 id="myapplet-set-default"> 
  465.         <title>Default List</title> 
  466.         <variablelist> 
  467.           <varlistentry> 
  468.              <term> 
  469.                 <guilabel>Default character list</guilabel></term> 
  470.              <listitem> 
  471.                 <para>Use this text box to specify your own default character
  472.                   list.</para> 
  473.              </listitem> 
  474.           </varlistentry> 
  475.         </variablelist> 
  476.      </sect2> 
  477.   </sect1>
  478.  
  479. <!-- ============= Bugs ================================== -->
  480. <!-- This section is optional and is commented out by default. 
  481.      You can use it to describe known bugs and limitations of the 
  482.       program if there are any - please be frank and list all
  483.      problems you know of. 
  484.   
  485.   <sect1 id="myapplet-bugs">
  486.   <title>Known Bugs and Limitations</title>
  487.   <para> </para>
  488.  </sect1>
  489. -->
  490. <!-- ============= About ================================== -->
  491. <!-- This section contains info about the program (not docs), such as
  492.      author's name(s), web page, license, feedback address. This
  493.      section is optional: primary place for this info is "About.." box of
  494.      the program. However, if you do wish to include this info in the
  495.      manual, this is the place to put it. Alternatively, you can put this 
  496.      information in the title page.-->
  497.  
  498.   <sect1 id="myapplet-about">
  499.     <title>About &applet;</title>
  500.       <para>
  501.         &applet; was written by GNOME-HACKER
  502.         (<email>hacker@gnome.org</email>). To find more information about
  503.         &applet;, please visit the <ulink
  504.         url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
  505.         page</ulink>. 
  506.       </para>  
  507.       
  508.       <para>
  509.       To report a bug or make a suggestion regarding this application or
  510.       this manual, follow the directions in the
  511.       <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>.
  512.       </para>
  513.  
  514.       <para> This program is distributed under the terms of the GNU
  515.       General Public license as published by the Free Software
  516.       Foundation; either version 2 of the License, or (at your option)
  517.       any later version. A 
  518.       <ulink url="ghelp:gpl" type="help">copy of this license</ulink>
  519.       is included with this documentation; another can be found in the file
  520.       COPYING included with the source code of this program.
  521.       </para>     
  522.       
  523.   </sect1> 
  524.  
  525. </article> 
  526.